/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Esta Anotação é utilizada para construção de transações para entidades.<br>
 * Uma transação possui um editor, uma busca e um painel de ações.<br>
 *
 * @see org.balisunrise.annotation.Editor
 * @see org.balisunrise.annotation.Search
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Transaction {

    /**
     * Representa o nome para construção desta transação.
     *
     * @return Retorna o nomes para esta definição de transação.
     */
    public String alias() default "";

    /**
     * Título da transação.
     * @return Retorna uma String que representa o título da transação.
     */
    public String title();

    /**
     * Alias do editor da transação.
     * @return Retorna o alias (nome) do editor que será utilizado na transação.
     */
    public String editor();

    /**
     * Alias da busca da transação.
     * @return Retorna o alias (nome) da busca que será utilizado na transação.
     */
    public String search();
}
